Meshtastic App/com.geeksville.mesh/[androidJvm]MeshProtos/Position

Position

class Position : GeneratedMessage, MeshProtos.PositionOrBuilder


A GPS Position

Protobuf type meshtastic.Position

Types

AltSource

enum AltSource : ProtocolMessageEnum


How the altitude was acquired: manual, GPS int/ext, etc
Default: same as location_source if present

Protobuf enum meshtastic.Position.AltSource

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , MeshProtos.PositionOrBuilder


A GPS Position

Protobuf type meshtastic.Position

LocSource

enum LocSource : ProtocolMessageEnum


How the location was acquired: manual, onboard GPS, external (EUD) GPS

Protobuf enum meshtastic.Position.LocSource

Properties

ALTITUDE_FIELD_NUMBER

val ALTITUDE_FIELD_NUMBER: Int = 3

ALTITUDE_GEOIDAL_SEPARATION_FIELD_NUMBER

val ALTITUDE_GEOIDAL_SEPARATION_FIELD_NUMBER: Int = 10

ALTITUDE_HAE_FIELD_NUMBER

val ALTITUDE_HAE_FIELD_NUMBER: Int = 9

ALTITUDE_SOURCE_FIELD_NUMBER

val ALTITUDE_SOURCE_FIELD_NUMBER: Int = 6

FIX_QUALITY_FIELD_NUMBER

val FIX_QUALITY_FIELD_NUMBER: Int = 17

FIX_TYPE_FIELD_NUMBER

val FIX_TYPE_FIELD_NUMBER: Int = 18

GPS_ACCURACY_FIELD_NUMBER

val GPS_ACCURACY_FIELD_NUMBER: Int = 14

GROUND_SPEED_FIELD_NUMBER

val GROUND_SPEED_FIELD_NUMBER: Int = 15

GROUND_TRACK_FIELD_NUMBER

val GROUND_TRACK_FIELD_NUMBER: Int = 16

HDOP_FIELD_NUMBER

val HDOP_FIELD_NUMBER: Int = 12

LATITUDE_I_FIELD_NUMBER

val LATITUDE_I_FIELD_NUMBER: Int = 1

LOCATION_SOURCE_FIELD_NUMBER

val LOCATION_SOURCE_FIELD_NUMBER: Int = 5

LONGITUDE_I_FIELD_NUMBER

val LONGITUDE_I_FIELD_NUMBER: Int = 2

NEXT_UPDATE_FIELD_NUMBER

val NEXT_UPDATE_FIELD_NUMBER: Int = 21

PDOP_FIELD_NUMBER

val PDOP_FIELD_NUMBER: Int = 11

PRECISION_BITS_FIELD_NUMBER

val PRECISION_BITS_FIELD_NUMBER: Int = 23

SATS_IN_VIEW_FIELD_NUMBER

val SATS_IN_VIEW_FIELD_NUMBER: Int = 19

SENSOR_ID_FIELD_NUMBER

val SENSOR_ID_FIELD_NUMBER: Int = 20

SEQ_NUMBER_FIELD_NUMBER

val SEQ_NUMBER_FIELD_NUMBER: Int = 22

TIME_FIELD_NUMBER

val TIME_FIELD_NUMBER: Int = 4

TIMESTAMP_FIELD_NUMBER

val TIMESTAMP_FIELD_NUMBER: Int = 7

TIMESTAMP_MILLIS_ADJUST_FIELD_NUMBER

val TIMESTAMP_MILLIS_ADJUST_FIELD_NUMBER: Int = 8

VDOP_FIELD_NUMBER

val VDOP_FIELD_NUMBER: Int = 13

Functions

copy

inline fun MeshProtos.Position.copy(block: PositionKt.Dsl.() -> Unit): MeshProtos.Position

equals

open fun equals(obj: Any): Boolean

getAltitude

open fun getAltitude(): Int


In meters above MSL (but see issue #359)

optional int32 altitude = 3;

getAltitudeGeoidalSeparation

open fun getAltitudeGeoidalSeparation(): Int


Geoidal separation in meters

optional sint32 altitude_geoidal_separation = 10;

getAltitudeHae

open fun getAltitudeHae(): Int


HAE altitude in meters - can be used instead of MSL altitude

optional sint32 altitude_hae = 9;

getAltitudeSource

open fun getAltitudeSource(): MeshProtos.Position.AltSource


TODO: REPLACE

.meshtastic.Position.AltSource altitude_source = 6;

getAltitudeSourceValue

open fun getAltitudeSourceValue(): Int


TODO: REPLACE

.meshtastic.Position.AltSource altitude_source = 6;

getDefaultInstance

open fun getDefaultInstance(): MeshProtos.Position

getDefaultInstanceForType

open fun getDefaultInstanceForType(): MeshProtos.Position

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getFixQuality

open fun getFixQuality(): Int


GPS fix quality (from NMEA GxGGA statement or similar)

uint32 fix_quality = 17;

getFixType

open fun getFixType(): Int


GPS fix type 2D/3D (from NMEA GxGSA statement)

uint32 fix_type = 18;

getGpsAccuracy

open fun getGpsAccuracy(): Int


GPS accuracy (a hardware specific constant) in mm
multiplied with DOP to calculate positional accuracy
Default: "'bout three meters-ish" :)

uint32 gps_accuracy = 14;

getGroundSpeed

open fun getGroundSpeed(): Int


Ground speed in m/s and True North TRACK in 1/100 degrees
Clarification of terms:
- "track" is the direction of motion (measured in horizontal plane)
- "heading" is where the fuselage points (measured in horizontal plane)
- "yaw" indicates a relative rotation about the vertical axis
TODO: REMOVE/INTEGRATE

optional uint32 ground_speed = 15;

getGroundTrack

open fun getGroundTrack(): Int


TODO: REPLACE

optional uint32 ground_track = 16;

getHDOP

open fun getHDOP(): Int


TODO: REPLACE

uint32 HDOP = 12;

getLatitudeI

open fun getLatitudeI(): Int


The new preferred location encoding, multiply by 1e-7 to get degrees
in floating point

optional sfixed32 latitude_i = 1;

getLocationSource

open fun getLocationSource(): MeshProtos.Position.LocSource


TODO: REPLACE

.meshtastic.Position.LocSource location_source = 5;

getLocationSourceValue

open fun getLocationSourceValue(): Int


TODO: REPLACE

.meshtastic.Position.LocSource location_source = 5;

getLongitudeI

open fun getLongitudeI(): Int


TODO: REPLACE

optional sfixed32 longitude_i = 2;

getNextUpdate

open fun getNextUpdate(): Int


Estimated/expected time (in seconds) until next update:
- if we update at fixed intervals of X seconds, use X
- if we update at dynamic intervals (based on relative movement etc),
but "AT LEAST every Y seconds", use Y

uint32 next_update = 21;

getParserForType

open fun getParserForType(): Parser<MeshProtos.Position>

getPDOP

open fun getPDOP(): Int


Horizontal, Vertical and Position Dilution of Precision, in 1/100 units
- PDOP is sufficient for most cases
- for higher precision scenarios, HDOP and VDOP can be used instead,
in which case PDOP becomes redundant (PDOP=sqrt(HDOP^2 + VDOP^2))
TODO: REMOVE/INTEGRATE

uint32 PDOP = 11;

getPrecisionBits

open fun getPrecisionBits(): Int


Indicates the bits of precision set by the sending node

uint32 precision_bits = 23;

getSatsInView

open fun getSatsInView(): Int


GPS "Satellites in View" number

uint32 sats_in_view = 19;

getSensorId

open fun getSensorId(): Int


Sensor ID - in case multiple positioning sensors are being used

uint32 sensor_id = 20;

getSeqNumber

open fun getSeqNumber(): Int


A sequence number, incremented with each Position message to help
detect lost updates if needed

uint32 seq_number = 22;

getSerializedSize

open fun getSerializedSize(): Int

getTime

open fun getTime(): Int


This is usually not sent over the mesh (to save space), but it is sent
from the phone so that the local device can set its time if it is sent over
the mesh (because there are devices on the mesh without GPS or RTC).
seconds since 1970

fixed32 time = 4;

getTimestamp

open fun getTimestamp(): Int


Positional timestamp (actual timestamp of GPS solution) in integer epoch seconds

fixed32 timestamp = 7;

getTimestampMillisAdjust

open fun getTimestampMillisAdjust(): Int


Pos. timestamp milliseconds adjustment (rarely available or required)

int32 timestamp_millis_adjust = 8;

getVDOP

open fun getVDOP(): Int


TODO: REPLACE

uint32 VDOP = 13;

hasAltitude

open fun hasAltitude(): Boolean


In meters above MSL (but see issue #359)

optional int32 altitude = 3;

hasAltitudeGeoidalSeparation

open fun hasAltitudeGeoidalSeparation(): Boolean


Geoidal separation in meters

optional sint32 altitude_geoidal_separation = 10;

hasAltitudeHae

open fun hasAltitudeHae(): Boolean


HAE altitude in meters - can be used instead of MSL altitude

optional sint32 altitude_hae = 9;

hasGroundSpeed

open fun hasGroundSpeed(): Boolean


Ground speed in m/s and True North TRACK in 1/100 degrees
Clarification of terms:
- "track" is the direction of motion (measured in horizontal plane)
- "heading" is where the fuselage points (measured in horizontal plane)
- "yaw" indicates a relative rotation about the vertical axis
TODO: REMOVE/INTEGRATE

optional uint32 ground_speed = 15;

hasGroundTrack

open fun hasGroundTrack(): Boolean


TODO: REPLACE

optional uint32 ground_track = 16;

hashCode

open fun hashCode(): Int

hasLatitudeI

open fun hasLatitudeI(): Boolean


The new preferred location encoding, multiply by 1e-7 to get degrees
in floating point

optional sfixed32 latitude_i = 1;

hasLongitudeI

open fun hasLongitudeI(): Boolean


TODO: REPLACE

optional sfixed32 longitude_i = 2;

isInitialized

fun isInitialized(): Boolean

newBuilder

open fun newBuilder(): MeshProtos.Position.Builder

open fun newBuilder(prototype: MeshProtos.Position): MeshProtos.Position.Builder

newBuilderForType

open fun newBuilderForType(): MeshProtos.Position.Builder

parseDelimitedFrom

open fun parseDelimitedFrom(input: InputStream): MeshProtos.Position

open fun parseDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): MeshProtos.Position

parseFrom

open fun parseFrom(data: Array<Byte>): MeshProtos.Position

open fun parseFrom(data: ByteString): MeshProtos.Position

open fun parseFrom(input: CodedInputStream): MeshProtos.Position

open fun parseFrom(input: InputStream): MeshProtos.Position

open fun parseFrom(data: ByteBuffer): MeshProtos.Position

open fun parseFrom(data: Array<Byte>, extensionRegistry: ExtensionRegistryLite): MeshProtos.Position

open fun parseFrom(data: ByteString, extensionRegistry: ExtensionRegistryLite): MeshProtos.Position

open fun parseFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): MeshProtos.Position

open fun parseFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): MeshProtos.Position

open fun parseFrom(data: ByteBuffer, extensionRegistry: ExtensionRegistryLite): MeshProtos.Position

parser

open fun parser(): Parser<MeshProtos.Position>

toBuilder

open fun toBuilder(): MeshProtos.Position.Builder

writeTo

open fun writeTo(output: CodedOutputStream)